home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / romd100.zip / ROMDOOR.DOC < prev    next >
Text File  |  1992-04-28  |  23KB  |  499 lines

  1.  
  2.                                                           ROMDOOR v1.00
  3. ───────────────────────────────────────────────────────────────────────
  4.                                                         CD-ROM Door for
  5.                                                   Wildcat v3.0x Systems
  6.                                                      Copyright (C) 1992
  7.                                                          by Jeff Bisson
  8.  
  9.  
  10.  
  11.                                                       TABLE OF CONTENTS
  12. ───────────────────────────────────────────────────────────────────────
  13.  
  14.         What is RomDoor .................................. 2
  15.         Copyright ........................................ 2
  16.         Liability ........................................ 2-3
  17.         Files included in the archive .................... 4
  18.         Setting up RomDoor with Wildcat 3.x .............. 4-8
  19.         Common Asked Questions ........................... 8
  20.         Command Line parameters .......................... 9
  21.         Registration ..................................... 9
  22.         Special Thanks ................................... 9
  23.         Problems, comments, and future versions .......... 10
  24.  
  25. ───────────────────────────────────────────────────────────────────────
  26.  
  27.     [Page 2, RomDoor v1.00]
  28.                                                        WHAT IS ROMDOOR?
  29. ───────────────────────────────────────────────────────────────────────
  30.  
  31. RomDoor is an online program which allows access to CD-ROMs and their vast 
  32. storage capablities.  It offers:
  33.  
  34.     ■ The ablity to run from 1-25 CD-ROMs, max of 2 in the non-registered
  35.       version
  36.     ■ Up to 1000 file areas
  37.     ■ Provides a seamless interface with WildCat!
  38.     ■ No need for 0 byte files
  39.     ■ It offers all the features of the WC! file section including:
  40.          ■ Text searchs
  41.          ■ File viewing (Provided you have an archive viewing program
  42.            such as DataView)
  43.          ■ Downloading with internal and external protocols
  44.     ■ It has an online statistics screen with the total files, bytes and
  45.       downloads each file area
  46.     ■ RomDoor keeps it's own database, unlike most CD-Rom doors
  47.     ■ RomDoor allows the user to make file listings ON-LINE of specific
  48.       file areas, I.E. list the files to a text file which they can
  49.       later download
  50.     ■ RomDoor supports baud rates up to 115,000, as well as non-standard base
  51.       addresses and IRQs
  52.     ■ RomDoor does full carrier detection, inactivity checking, ratio
  53.       checking, and increments the users total downloads, etc.
  54.  
  55. Give RomDoor a try, your users (and you!) will appreciate it!
  56.  
  57.  
  58.                                                               COPYRIGHT
  59. ───────────────────────────────────────────────────────────────────────
  60.  
  61. RomDoor (Version 1.0) is distributed under the Shareware concept.  You
  62. are granted a limited license to use and share it under the following
  63. conditions:
  64.  
  65. ■  RomDoor is not distributed in a modified form.
  66. ■  No fee is charged for RomDoor itself.
  67. ■  All references to the copyright and author are retained.
  68.  
  69. There is a small fee for this program.  Please read the registration
  70. section.
  71.  
  72. This program is:
  73. Copyright (c) 1992, Jeff S. Bisson, All Rights Reserved.
  74.  
  75.                                                               LIABILITY
  76. ───────────────────────────────────────────────────────────────────────
  77.  
  78. Normally, software distributed through bulletin boards systems or
  79. shared from one user to another does not carry a warranty, mainly
  80. because the author does not have control over the product and the
  81. program can be modified either intentionally or accidentally
  82. without the author's knowledge.
  83.  
  84.  
  85.     [Page 3, RomDoor v1.00]
  86.  
  87. With that in mind RomDoor has a limited warranty if you receive it
  88. directly from the author.  If the program was not received directly from
  89. the author then there is a chance that the the documentation or the program
  90. itself of having been modified.  In that case there is no warranty, and
  91. the author will not be liable for any damages, whether direct, indirect,
  92. special or consequential arising from a failure of this program to operate
  93. in the manner desired by the user.  The author will not be liable for any
  94. damage to data or property which may be caused directly or indirectly by
  95. use of the program.
  96.  
  97.    - What is covered:  The RomDoor program will perform substantially
  98.         as described in this document.  In addition, while the program
  99.         may contain minor bugs or errors, it is warranted to be free
  100.         of major defects for a period of six months.  Diskettes received
  101.         from the author are guaranteed to be free or defects for a period
  102.         of six months from date of receipt.
  103.  
  104.    - What is not covered:  The author will not be liable for incidental
  105.         and/or consequential damages, including injury to property,
  106.         interruption of service, loss of business and/or anticipated
  107.         profits, or other consequential damages that may result from use,
  108.         malfunction or failure of the RomDoor program, or from errors or
  109.         omissions in the documentation.  Some states do not allow the
  110.         exclusion or limitation of incidental or consequential damages,
  111.         so the above limitation may not apply to you.
  112.  
  113.      Any attempt to modify the RomDoor program will void this warranty
  114.      in its entirety.
  115.  
  116.    - If there is a problem:  Within 60 days of notification that a major
  117.         defect exists, the author, at his discretion, will either fix the
  118.         program and forward the replacement at no cost to the registered
  119.         user, or will refund the registration fee.
  120.  
  121.      Defective diskettes will be replaced within 60 days at no cost
  122.         to the purchaser.
  123.  
  124.    - How to get service:  Send a written letter to the author detailing
  125.         the type of problem and symptoms experienced.  Include your name,
  126.         address, voice phone number and registration number and any
  127.         additional information that you believe may be useful, such as
  128.         any TSRs and disk cache programs in use.  The author may contact
  129.         you by voice or written letter for more information to help in
  130.         tracking down the problem.
  131.  
  132. When trying new software, always backup any and all important files
  133. on your system.
  134.  
  135.  
  136.     [Page 4, RomDoor v1.00]
  137.                                           FILES INCLUDED IN THE ARCHIVE
  138. ───────────────────────────────────────────────────────────────────────
  139.              │
  140. ROMDOOR.DOC  │ RomDoor documentation, you are reading it!
  141.              │
  142. ROMDOOR.EXE  │ RomDoor program and configuration.
  143.              │
  144. SAMPLE.BAT   │ Sample door batch file for WildCat 3.0x systems.
  145.              │
  146. ROMDOOR.HLP  │ Help file for MakeRom, DirToDat, and WC2Rom.
  147.              │
  148. ONLINE.HLP   │ Online help file for RomDoor.
  149.              │
  150. REGISTER.DOC │ Registration Information and form for RomDoor v1.00.
  151.              │
  152. DIRTODAT.EXE │ Imports text files into your RomDoor database.
  153.              │
  154. MAKEROM.EXE  │ Configuration program for RomDoor.           
  155.              │
  156. WC2ROM.EXE   │ Moves file areas from WC! to RomDoor's file database.
  157.              │ Press F1 in program for info on it's use.
  158.  
  159.  
  160.                                     SETTING UP ROMDOOR WITH WILDCAT 3.x
  161. ───────────────────────────────────────────────────────────────────────
  162.  
  163. RomDoor is quite easy to set up, although it can take some time to do 
  164. everything correctly.  The process is not hard, but it is quite
  165. repetitive.  Over all it is worth the trouble.
  166.  
  167. 1) Take a deep breath.
  168.  
  169. 2) Extract the RomDoor archive somewhere on your hard drive.  For ease of
  170. setting it up, put it in it's own subdirectory to keep the files out of your
  171. way.  Print out these instructions because you will most likely be installing
  172. another CD-Rom into RomDoor in the future and you will need to know what to
  173. do.  KEEP THIS FILE AS A REFERENCE!
  174.  
  175. 3) With your CD-ROM came some text files listing the files that are on the 
  176. CD-ROM.  Put those somewhere where you will remember, you will need them 
  177. later.  Before you start importing the textfiles into the RomDoor database 
  178. you have to tell RomDoor the format of the textfile i.e. location of the
  179. filename, date, and description.  To do this I have included DIRTODAT to
  180. make it as easy as possible.  To configure DIRTODAT you may type
  181. DIRTODAT CONFIG at the command line or press ALT-D inside MAKEROM.
  182.  
  183. (* NOTE * EVERY textfile that you are going to import cannot have ANY
  184.           blank lines or multiple line descriptions UNLESS a "|" character
  185.           denotes the beginning of the description)
  186.  
  187.  
  188.     [Page 5, RomDoor v1.00]
  189.  
  190. Once inside DIRTODAT press:
  191.  
  192.   ■ INS to add a new record
  193.   ■ Type in the name of one of the textfiles
  194.   ■ You will then be prompted with a question asking you what name you want
  195.     to identify the record with, for ease of remembering type in the CD-ROM's
  196.     name.
  197.   ■ Now you will be presented with a line (in the middle window) that
  198.     comes from the text file.  If the line is blank or doesn't have the
  199.     correct information, read the NOTE above.
  200.   ■ Follow the directions in the bottom window and press F10.
  201.   ■ Exit DIRTODAT
  202.  
  203. 4) If you are not already in MAKEROM, load it up.  Press ALT-C to edit the
  204. CD-ROMs, enter the name of the CD-ROM then press TAB to enter the drive 
  205. letter.  Press F10 to save changes.
  206.  
  207. 5) Next you have to enter the file area descriptions, area paths, and
  208. CD-ROM numbers in each file area.  If you have DesqView then you are in luck,
  209. this process will be a lot easier.  
  210.  
  211. * Note about the paths: Since the CD-ROM's drive letter has already been
  212.   designated, you do not need to include the drive letter when you type in
  213.   the path.  i.e. \GIF\NATURE instead of I:\GIF\NATURE.
  214.  
  215. Hopefully your CD-ROM disk came with a textfile that lists the area name
  216. and path, you will be using this to enter the correct information in the
  217. file areas.  If you don't have DesqView then you have to manually go through
  218. the file areas entering the name, paths and CD-ROM number in every file area.
  219.  
  220. If you do have DesqView then what you should do is mark the text from
  221. the textfile i.e. the file area names and paths.  Transfer this information
  222. into MakeRom; this makes the process close to automatic.  If you need some
  223. help on the process read on, if you can figure it out move on to step 6.
  224.  
  225.   ■ Have MAKEROM and DOS loaded in two different windows.  Use any text
  226.     file viewer, LIST.COM will do, to view the text file that lists the
  227.     file areas and paths.
  228.  
  229.   ■ Switch to the window which contains your text file.  Then Mark the text
  230.     in the textfile.  Press:
  231.     ■ The DV key to get to the DV menu.
  232.     ■ M for mark and move the cursor to where the file area name begins.
  233.     ■ B to begin marking and move the cursor so that all the file area
  234.       names are marked.  (*NOTE* DV will only allow you to do one screen
  235.       at a time)
  236.     ■ ENTER to mark the text.
  237.  
  238.   ■ Switch to MakeRom.
  239.     ■ Move to the file area that you want to start with and press ENTER.
  240.     ■ Start at the file area name field and press the DV Key.
  241.     ■ T for transfer, and T once more to transfer the first line.
  242.  
  243.  
  244.     [Page 6, RomDoor v1.00]
  245.  
  246.     ■ Now you need to tell DV the keys to execute between each line you
  247.       transfer.
  248.       ■ F10 to save the record.
  249.       ■ The Right arrow to move to the next area.
  250.       ■ ENTER to edit that area.
  251.     ■ Now you are ready to tell DV to transfer the rest of the data.
  252.     ■ The DV Key, T for transfer and R for the Rest of the data.
  253.  
  254. Once you have the file area names in the correct fields continue with the
  255. rest of the data.
  256.  
  257. It may seem like a complicated process but it really isn't that hard, just 
  258. read carefully.  
  259.  
  260.   (*NOTE* Don't forget about the CD-Rom number, you have to set that for
  261.           EACH area that you are planning to import)
  262.  
  263. Before going onto the next step make sure that:
  264.  
  265.   The file areas have names, correct paths, and have been assigned to a
  266.   CD-ROM, via CD-ROM Number.
  267.  
  268. 6) Next press ALT-O, you will be presented with a menu that shows you five 
  269. different fields:
  270.  
  271.   Network: If you are running off of a network then change this to either
  272.     SHARE or NOVELL, this should be the same as in MAKEWILD.  Default NONET.
  273.  
  274.   Flow Control: Here are some guidelines on choosing flow control:
  275.  
  276.        If you are running a high speed modem, or an error correcting modem,
  277.        then choose "Hardware Flow Control, (CTS/RTS)".  If you have a
  278.        standard 2400 or an (ouch) 1200 bps modem, then choose "No Flow
  279.        Control".  Other options are available, such as "Software Flow
  280.        Control, (Xon/Xoff)" as well as "Both Hardware and Software flow
  281.        control", but they are rarely used.
  282.  
  283.   DataBase Path: The directory that contains ROM.DAT and ROM.IX, if
  284.     left blank RomDoor will default to the current directory.
  285.  
  286.   Default Extension: This is the default file extension that will be
  287.     used when a download is requested, provided a file without an extension
  288.     is not located.
  289.  
  290.   External Protocols: This reads in the external protocols that you have
  291.     specified in MakeWild and allows you to select which ones will be 
  292.     offered from RomDoor.  Don't put any two-way protocols i.e. BiModem or
  293.     HsLink since RomDoor will not check for uploaded files and it may 
  294.     create problems.
  295.  
  296.   BBS ID: This is for the naming of the area listings that the user
  297.     creates when they make a list.  Enter the most significant letters of
  298.     your boards name.  I.E. Illusions enter in ILLUSION
  299.  
  300.     NOTE This feature is only available in the registered version of
  301.          RomDoor.
  302.  
  303.  
  304.     [Page 7, RomDoor v1.00]
  305.  
  306. 7) The next step is to configure the security levels.  To do this press
  307.    ALT-S in MakeRom, you will be presented a list of the security levels
  308.    that you have defined in MakeWild.  Press ENTER on the security level to
  309.    configure, you will see a list of the CD-ROMs that you have in RomDoor.
  310.    Press the SPACE BAR to toggle whether that security level has access to
  311.    that specific CD-ROM.  You can also change the access to the certain file
  312.    areas by pressing the TAB key.  You will now be presented a list of all
  313.    the RomDoor file areas.  Just press the SPACE BAR to toggle the access.
  314.    Press F10 to save changes.
  315.  
  316. 8) Now you are ready to start importing.  Go to the file area you are going
  317.    to import into and press ALT-I.  You will be asked for a file name;
  318.    enter the name of the textfile that contains the file information for
  319.    that area.  You will then be asked for the Directory Setup Number, which
  320.    is the number of the text file information that you entered in DIRTODAT.
  321.    If you are unsure of the number press F2 to get a picklist and select the
  322.    correct setup number.  Press "Y"es if the information in the box is
  323.    correct.  Now MakeRom should be importing the files into the RomDoor
  324.    database.  Repeat this step for all of the file areas on this disk.
  325.    If you make a mistake you can press ALT-R to remove the area that you
  326.    are on.
  327.  
  328. 9) Repeat steps 3-8 for every CD-ROM that you are importing into RomDoor.
  329.  
  330.    *** IMPORTANT ***
  331.  
  332.      Back up the RomDoor database (ROM.DAT, ROM.IX & ROMAREAS.DAT) after
  333.      each CD-ROM just in case...
  334.  
  335. 10) Next, exit the configuration program and setup your door batch file.
  336.     An example is included in the file SAMPLE.BAT.  This batch file
  337.     should change to the directory that RomDoor is located in, and then
  338.     execute RomDoor with no command line parameters.  It should look
  339.     something like this:
  340.  
  341.       SET CDSONLINE = 1
  342.       CD\ROMDOOR
  343.       ROMDOOR
  344.  
  345.     Its that simple!  You may be wondering "what is SET CDSONLINE = 1"?
  346.     This tells RomDoor which CDs are currently online.  This allows
  347.     you to have multiple CDs for only one CD-ROM drive.  Valid settings for
  348.     CDSONLINE are:
  349.  
  350.       #    i.e. 1 or 2
  351.       #, # i.e. 1, 2, 3 or 1, 3, 5
  352.       #-#  i.e. 1-3 or 1-4 or 5-25
  353.       Or any such combinations.
  354.  
  355.     If you are getting an error when you call this batch file from WC!
  356.     such as "Out of Environment Space" put a SET CDSONLINE= line in your 
  357.     AUTOEXEC.BAT, the problem is that DOS won't allocate any memory for
  358.     environmental variables from a shell.  You can still change the
  359.     CDSONLINE enviromental variable from the DOOR# batch file, but you
  360.     can't make a new environmental variable in a shell.
  361.  
  362.  
  363.     [Page 8, RomDoor v1.00]
  364.  
  365. 11) Don't forget to configure WildCat! for the new door.  You will need to
  366.     load MakeWild and make sure there is a door number available.  Lets say
  367.     this is door #3.  The sample batch file that you made in step #6 would
  368.     be called DOOR3.BAT and would be located in your home directory
  369.     (i.e. C:\WC30).  RomDoor will also run from a DOS HOOK from any of the
  370.     menus, i.e. from the file menu the batch file would be FILE1.BAT or
  371.     FILE2.BAT.
  372.  
  373. 12) You may now exhale, you are done!  Give RomDoor a test drive to make
  374.     sure everything is working correctly.
  375.  
  376.  
  377.                                                  COMMON ASKED QUESTIONS
  378. ───────────────────────────────────────────────────────────────────────
  379.  
  380. Question: I have imported the files into the database and setup the
  381.           files areas.  But when I go into RomDoor I can't see the file
  382.           areas.
  383.  
  384. Answer: There are a two possible reasons why you are have this problem.
  385.  
  386.   1) Check to make sure that you have given your security level access
  387.      to those file areas.  NOTE to give a security level access to a
  388.      CD-ROM make sure that the correct CD-ROM Number is in the filearea
  389.      records.  Then press ALT-S, and select the security level to change
  390.      by pressing ENTER.  Move to the CD-ROM in question and press the
  391.      SPACE BAR to tag it.  Just in case, press TAB and check to make
  392.      sure that the fileareas on that CD-ROM were tagged.
  393.  
  394.   2) The environmental variable CDSONLINE needs to be changed.  Check
  395.      what the environmental variable is set by loading up RomDoor and
  396.      pressing F9, look at the bottom of the info screen on the left and
  397.      it should say what it is set at.  If the CD-ROM in question is not
  398.      included then that is the problem.
  399.  
  400. Question: Users are having problems downloading, they keep getting CRC
  401.           errors.
  402.  
  403. Answer: If you have a high speed modem (9600+) then you need to set the
  404.         flow control to CTS/RTS.
  405.  
  406. Question: I changed a security level in MakeWild! but RomDoor doesn't
  407.           seem to know that I changed it.
  408.  
  409. Answer: Whenever you changed a security level in WC! you need to make
  410.         sure you load up MakeRom and update the security file.  To do
  411.         this press ALT-S, and then ALT-U for update.
  412.  
  413.  
  414.     [Page 9, RomDoor v1.00]
  415.                                                 COMMAND LINE PARAMETERS
  416. ───────────────────────────────────────────────────────────────────────
  417.  
  418. RomDoor has two command line parameters: LOCAL and NOLOG
  419.  
  420.   Using LOCAL will tell RomDoor that you are running it from the
  421.   command line and not to look for the DOOR.SYS and USERINFO.DAT files.
  422.   RomDoor will get the sysop's name from MAKEWILD.DAT, will get your
  423.   security level from the ALLUSERS.DAT, and it will give you 5 hours.
  424.  
  425.   Using NOLOG will tell RomDoor that you do not want it to create a log
  426.   file.  Normally RomDoor creates a file called RDOOR##.LOG in the directory
  427.   that you execute RomDoor from, using this parameter nullifys this action.
  428.  
  429. Here are examples:
  430.  
  431. ROMDOOR LOCAL    ; Run RomDoor in local mode.
  432. ROMDOOR NOLOG    ; Run RomDoor with out making a RDOOR##.LOG file.
  433.  
  434.  
  435.                                                            REGISTRATION
  436. ───────────────────────────────────────────────────────────────────────
  437.  
  438. Why should you register?
  439.  
  440. First of all you should register if you like RomDoor and plan to keep it
  441. on your system.  You must register if you use RomDoor for more then the
  442. 30 day trial period.  Registration allows you free upgrades to most future
  443. versions, major upgrades that involve substantial changes may require a
  444. nominal fee.  All future version will be available on the boards listed
  445. on the next page.  With registration you will also get additional programs
  446. such as ROMEDIT, ROMCHK, and FIXROM (Descriptions are located in
  447. REGISTER.DOC).  You will also have the ability to create your own menus
  448. for use with RomDoor using ANSI.  For the larger boards, you will be
  449. able to offer up to 25 CD-ROMs.  Unregistered versions are limited to two.
  450. You will also give the user the ability to create textfile listings ON-LINE.
  451.  
  452.  
  453.                                                          SPECIAL THANKS
  454. ───────────────────────────────────────────────────────────────────────
  455.  
  456. First of all I would like to thank Ralph Maya who helped me test out
  457. RomDoor through all of it's problems.  It was not an easy task.  He has
  458. given me so many suggestions to make the program better, and a lot of
  459. the program's design and function wouldn't be here if it wasn't for Ralph.
  460.  
  461. Second I would like to thank John Choi of Infinite Data Source for 
  462. suggesting RomDoor as a program to write and for giving me suggestions
  463. along the way.
  464.  
  465. Lastly I want to thank Jim Metzler for his help in making the documentation
  466. better and easier to read.
  467.  
  468.  
  469.     [Page 10, RomDoor v1.00]
  470.                                    PROBLEMS, COMMENTS & FUTURE VERSIONS
  471. ───────────────────────────────────────────────────────────────────────
  472.  
  473. If you have any problems with RomDoor, you can contact me on:
  474.  
  475. Illusions BBS, SysOp Ralph Maya
  476.   Node 1: (703) 641-0173  Dual Standard 14.4K HST, v.32 9600
  477.   Node 2: (703) 641-9218  2400
  478.  
  479. Data Connection BBS, SysOp Ryan Cramer
  480.   Node 1: (703) 506-8598  v.32 9600
  481.  
  482. Infinate Data Source, SysOp John Choi
  483.   (703) 642-8704  2400/9600 CompuCom
  484.   (703) 642-9882  9600 v.32 
  485.   (703) 642-9884  Dual Standard 14.4K HST, 14.4K v.32bis 
  486.  
  487. You may also reach me voice.
  488.   (703) 821-3776
  489.  
  490. Or you can send me a message in the WC! conference on RIME.  If all else 
  491. fails.  Try this:
  492.  
  493. Jeff Bisson
  494. 8210 Hunting Hill Lane
  495. McLean, VA  22102
  496.  
  497. The current version of RomDoor will always be on BBS's listed above as well
  498. as WildCat! HQ.
  499.